home *** CD-ROM | disk | FTP | other *** search
/ Aminet 15 / Aminet 15 - Nov 1996.iso / Aminet / dev / misc / BST_SystemDocs.lha / BeastV1 / Docs / ROBO_Docs / BST_ApplicationClass.doc < prev    next >
Encoding:
Text File  |  1996-04-19  |  4.2 KB  |  191 lines
  1. TABLE OF CONTENTS
  2. 0001 BST_ApplicationClass/BST_ApplicationInstance
  3. 0002 BST_ApplicationClass/mth_AddEvent_BST_Application
  4. 0003 BST_ApplicationClass/mth_Dispose_BST_Application
  5. 0004 BST_ApplicationClass/mth_EventLoop_BST_Application
  6. 0005 BST_ApplicationClass/mth_GetAttr_BST_Application
  7. 0006 BST_ApplicationClass/mth_Init_BST_Application
  8. 0007 BST_ApplicationClass/mth_RemEvent_BST_Application
  9. 0008 BST_ApplicationClass/mth_SetAttr_BST_Application
  10. 0009 Beast/BST_ApplicationClass
  11. BST_ApplicationClass/BST_ApplicationInstance
  12.  
  13. NAME
  14.       BST_ApplicationInstance - (under construction)
  15.  
  16.  
  17. BST_ApplicationClass/mth_AddEvent_BST_Application
  18.  
  19. NAME
  20.       mth_AddEvent - Add an event. (V1 Bravo)
  21.  
  22.  
  23. FUNCTION
  24.       Add an event to the list. See OBM_ADDEVENT.
  25.  
  26.  
  27. INPUTS
  28.       See OBM_ADDEVENT.
  29.       TagList -
  30.         BTA_Signals    - af[T( BTA_type_Flags )]
  31.           The signal flag on which the event will react.
  32.         BTA_MsgPort    - af[]
  33.           The Messageport of the event, if available.
  34.           Intuition GetMsg is used to retrieve the message.
  35.         BTA_Method    - af[D( OBM_IDMCPOUTPUT )]
  36.           The method which is triggered when a event occures.
  37.  
  38.  
  39. BST_ApplicationClass/mth_Dispose_BST_Application
  40.  
  41. NAME
  42.       mth_Dispose - Dispose the object. (V1 Bravo)
  43.  
  44.  
  45. BST_ApplicationClass/mth_EventLoop_BST_Application
  46.  
  47. NAME
  48.       mth_EventLoop - Enter the eventloop. (V1 Bravo)
  49.  
  50.  
  51. FUNCTION
  52.       The eventloop is entered. See OBM_EVENTLOOP.
  53.       The method returns when a BREAK_CTRL_C signal is received, or the
  54.       object will be destroyed.
  55.  
  56.       The triggered method are supplied with an TagList containing the
  57.       following tags.
  58.         BTA_Message    -    af[A]
  59.             Pointer to a Intuition Message structure.
  60.         BTA_MainObject    -    af[A]
  61.             Pointer to this Application object.
  62.  
  63.  
  64. INPUTS
  65.       See OBM_EVENTLOOP.
  66.  
  67.  
  68. BST_ApplicationClass/mth_GetAttr_BST_Application
  69.  
  70. NAME
  71.       mth_GetAttr - Get attributes. (V1 Bravo)
  72.  
  73.  
  74. FUNCTION
  75.       Get the application attributes. See OBM_GETATTR
  76.  
  77.  
  78. INPUTS
  79.       See mth_GetAttr_BST_BaseClass.
  80.       TagList -
  81.         BTA_Signals    - af[IFT( BTA_type_Flags )]
  82.             The current application wait signals.
  83.  
  84.  
  85. BST_ApplicationClass/mth_Init_BST_Application
  86.  
  87. NAME
  88.       mth_Init - Init object. (V1 Bravo)
  89.  
  90.  
  91. FUNCTION
  92.       Init the object.
  93.       Function equal to the OBM_SETATTR method.
  94.  
  95.  
  96. SEE ALSO
  97.       mth_SetAttr_BST_ApplicationClass
  98.  
  99.  
  100. BST_ApplicationClass/mth_RemEvent_BST_Application
  101.  
  102. NAME
  103.       mth_RemEvent - Remove event. (V1 Bravo)
  104.  
  105.  
  106. FUNCTION
  107.       Remove an event from the list. See OBM_REMEVENT.
  108.  
  109.  
  110. INPUTS
  111.       See OBM_REMEVENT.
  112.       TagList -
  113.         BTA_Signals    - af[T( BTA_type_Flags )]
  114.             The event with this signal is removed.
  115.             If the tag is not supplied (or is 0) all events of the
  116.             BTA_MainObject are removed.
  117.  
  118.  
  119. BST_ApplicationClass/mth_SetAttr_BST_Application
  120.  
  121. NAME
  122.       mth_SetAttr - Set Attributes(V1 Bravo)
  123.  
  124.  
  125. FUNCTION
  126.       Set the application class attributes. See OBM_SETATTR.
  127.  
  128.  
  129. INPUTS
  130.       See mth_SetAttr_BST_BaseClass.
  131.       TagList -
  132.         BTA_Signals    - af[IFT( BTA_type_Flags )]
  133.             Set the current application wait signals.
  134.         BTA_Signals_AND    - af[IFT( BTA_type_Flags )]
  135.             And the value with the current application wait signals.
  136.         BTA_Signals_OR    - af[IFT( BTA_type_Flags )]
  137.             Or the value with the current application wait signals.
  138.         BTA_Signals_XOR    - af[IFT( BTA_type_Flags )]
  139.             Xor the value with the current application wait signals.
  140.  
  141.  
  142. Beast/BST_ApplicationClass
  143.  
  144. NAME
  145.       BST_ApplicationClass -- (V1 Bravo)
  146.  
  147.  
  148. COPYRIGHT
  149.       Maverick Software Development
  150.  
  151.     SUPERCLASS
  152.       BST_BaseClass
  153.  
  154.  
  155. FUNCTION
  156.       The general Application classes, does the event handling.
  157.  
  158.         The method names are defined as follows;
  159.         mth_[method name]_[class name]
  160.  
  161.         The following tokens are used to explain the methods.
  162.  
  163.         af[..] = Attribute flags;
  164.             R    = Required, must be supplied.
  165.             P    = When not available, the method will try retrieve it from it's parents.
  166.             S    = This tag is used/filled in by a superclass of this class.
  167.             E    = When supplied the object will act more efficient.
  168.             D(n) = Default value when it's not supplied and it cannot be retrieved
  169.                    from something else.
  170.             A    = Always supplied by the method.
  171.             F    = This tag is filled in by the method.
  172.             I    = BTF_Ignore flag is set when processed.
  173.             T(n) = Extra information about the typeof the tag.
  174.  
  175.  
  176. AUTHOR
  177.       Jacco van Weert
  178.  
  179.  
  180. CREATION DATE
  181.       4-Apr-96
  182.  
  183.  
  184. MODIFICATION HISTORY
  185.  
  186.  
  187. NOTES
  188.  
  189.  
  190.  
  191.